--Lua Scripting Documentation
--Scripting is done in Lua version 5.3.0. Go to Lua.org for information on how to program using lua.

--TIME
--Do nothing for a certain amount of time
void HourSleep(int hrs)
void MinSleep(int mins)
void SecSleep(int secs)
void MilliSleep(int milliseconds)
void MicroSleep(int microseconds)
void NanoSleep(int nanoseconds)



--KEYBOARD
--Functions that input the key as if it was physically done on the keyboard
void PressKey(string key)
void ReleaseKey(string key)
void PressKeyVK(int VK_Code)
void ReleaseKeyVK(int VK_Code)


--Functions that press and release the key with a sleep call after each input. The default is 50ms sleep after pressed and 50ms sleep after released.
void HitKey(string key)
void HitKey(string key, double pressTimeMS, double releaseTimeMS)
void HitKeyVK(int VK_Code)
void HitKeyVK(int VK_Code, double pressTimeMS, double releaseTimeMS)


--Functions to check if the key is pressed or released
bool KeyPressed(string key)
bool KeyReleased(string key)
bool KeyPressedVK(int VK_Code)
bool KeyReleasedVK(int VK_Code)


--Types the string
void TypeString(string stringValue)


--Types only the first character in the string
void TypeChar(string value)


--Hits the key after holding down the modifier. After hitting the key the modifier is released.
void HitKeyAfterModifier(string key, string modifier)
void HitKeyAfterModifier(string key, string modifier, double pressTimeMS, double releaseTimeMS)



--MOUSE
--Functions that input the mouse button as if it was physically done on the mouse

void PressMouseButton(string mouseButton)
void ReleaseMouseButton(string mouseButton)
void PressMouseButtonVK(int VK_Code)
void ReleaseMouseButtonVK(int VK_Code)


--Functions that press and release the mouse button with a sleep call after each input. The default is 50ms sleep after pressed and 50ms sleep after released.
void HitMouseButton(string mouseButton)
void HitMouseButton(string mouseButton, double pressTimeMS, double releaseTimeMS)
void HitMouseButtonVK(int VK_Code)
void HitMouseButtonVK(int VK_Code, double pressTimeMS, double releaseTimeMS)


--Functions to check if the mouse button is pressed or released
bool MouseButtonPressed(string mouseButton)
bool MouseButtonReleased(string mouseButton)
bool MouseButtonPressedVK(int VK_Code)
bool MouseButtonReleasedVK(int VK_Code)


--Returns the current mouse position in pixel coordinates
(int x, int y) GetMousePosition()


--Sets the mouse position to the pixel on the screen where the width is x and the height is y.
--x increases from left to right where left is 0
--y increases from top to bottom where top is 0
void SetMousePosition(int x, int y)


--moves mouse to the location (x,y) over a period of time in milliseconds
void MoveMouse(int x, int y, float ms)


--left click and drag mouse over a period of time in milliseconds
void DragMouse(int x, int y, float ms)


--moves the mouse by dx and dy as raw mouse input. (Not measured in pixels. If you want pixels use SetMousePosition)
void ChangeMousePosition(int dx, int dy)


--Scrolls the mouse wheel Up (positive) or Down (negative). A scrollStrength of 1 is the default strength.
void MouseWheel(float scrollStrength)



--INFORMATION
--Convert from and to virtual key codes
int FromStringToVirtualKey(string key);
string FromVirtualKeyToString(int VK_Code);


--Writes to the Lua Log in the gui if it's enabled. Does not do a new line after logging so you need "\n" at the end of the string if you want a new line.
void Log(string log)


--Strings used for the keys
if it is a number the string is "numberValue". 
Example: PressKey("1") --Presses the 1 key on the keyboard

if it is a letter the string is "CapitalLetter". 
Example: HitKey("A") --Hits the A key (the letter must be upper case)

if it is a function key the string is "FfunctionValue" with the highest function being F24. 
Example: KeyPressed("F1") --returns true if the F1 function key is pressed

if it is a punctuation key the string is "punctuation". 
Example: ReleaseKey(".") --Releases the period key.

There is one EXCEPTION The \ key must be done as such: 
HitKey("\\") -- this is the \ key which needs the extra \ because it is a special character for strings

For the rest of the keys they use a specific string which are as follows:

VK_LBUTTON = "MouseLeft"
VK_RBUTTON = "MouseRight"

VK_CANCEL = "Cancel"

VK_MBUTTON = "MouseMiddle"
VK_XBUTTON1 = "MouseX1"
VK_XBUTTON2 = "MouseX2"

VK_BACK = "Backspace"
VK_TAB = "Tab"
VK_CLEAR = "Clear"
VK_RETURN = "Return"
VK_SHIFT = "Shift"
VK_CONTROL = "Control"
VK_MENU = "Alt"
VK_PAUSE = "Pause"
VK_CAPITAL = "CapsLock"

VK_KANA = "Kana"
VK_HANGEUL = "Hanguel"
VK_HANGUL = "Hangul"
VK_JUNJA = "Junja"
VK_FINAL = "Final"
VK_HANJA = "Hanja"
VK_KANJI = "Kanji"

VK_ESCAPE = "Escape"

VK_CONVERT = "Convert"
VK_NONCONVERT = "NonConvert"
VK_ACCEPT = "Accept"
VK_MODECHANGE = "ModeChange"

VK_SPACE = "Space"
VK_PRIOR = "PgUp"
VK_NEXT = "PgDown"
VK_END = "End"
VK_HOME = "Home"

VK_LEFT = "Left"
VK_UP = "Up"
VK_RIGHT = "Right"
VK_DOWN = "Down"

VK_SELECT = "Select"
VK_PRINT = "Print"
VK_EXECUTE = "Execute"
VK_SNAPSHOT = "SnapShot"

VK_INSERT = "Insert"
VK_DELETE = "Delete"
VK_HELP = "Help"

VK_LWIN = "LWindow"
VK_RWIN = "RWindow"
VK_APPS = "Apps"
VK_SLEEP = "Sleep"

VK_NUMPAD0 = "Num0"
VK_NUMPAD1 = "Num1"
VK_NUMPAD2 = "Num2"
VK_NUMPAD3 = "Num3"
VK_NUMPAD4 = "Num4"
VK_NUMPAD5 = "Num5"
VK_NUMPAD6 = "Num6"
VK_NUMPAD7 = "Num7"
VK_NUMPAD8 = "Num8"
VK_NUMPAD9 = "Num9"
VK_MULTIPLY = "Multiply"
VK_ADD = "Add"
VK_SEPARATOR = "Separator"
VK_SUBTRACT = "Subtract"
VK_DECIMAL = "Decimal"
VK_DIVIDE = "Divide"

VK_NUMLOCK = "NumLock"
VK_SCROLL = "ScrollLock"

VK_LSHIFT = "LShift"
VK_RSHIFT = "RShift"
VK_LCONTROL = "LControl"
VK_RCONTROL = "RControl"
VK_LMENU = "LAlt"
VK_RMENU = "RAlt"

VK_BROWSER_BACK = "BrowserBack"
VK_BROWSER_FORWARD = "BrowserForward"
VK_BROWSER_REFRESH = "BrowserRefresh"
VK_BROWSER_STOP = "BrowserStop"
VK_BROWSER_SEARCH = "BrowserSearch"
VK_BROWSER_FAVORITES = "BrowserFavorites"
VK_BROWSER_HOME = "BrowserHome"

VK_VOLUME_MUTE = "VolumeMute"
VK_VOLUME_DOWN = "VolumeDown"
VK_VOLUME_UP = "VolumeUp"
VK_MEDIA_NEXT_TRACK = "MediaNext"
VK_MEDIA_PREV_TRACK = "MediaPrevious"
VK_MEDIA_STOP = "MediaStop"
VK_MEDIA_PLAY_PAUSE = "MediaPlayPause"
VK_LAUNCH_MAIL = "LaunchMail"
VK_LAUNCH_MEDIA_SELECT = "MediaSelect"
VK_LAUNCH_APP1 = "LaunchApp1"
VK_LAUNCH_APP2 = "LaunchApp2"

VK_OEM_8 = "OEM8"
VK_OEM_102 = "OEM102"

VK_PROCESSKEY = "Process"
VK_PACKET = "Packet"
VK_ATTN = "Attn"
VK_CRSEL = "CrSel"
VK_EXSEL = "ExSel"
VK_EREOF = "EraseEOF"
VK_PLAY = "Play"
VK_ZOOM = "Zoom"
VK_NONAME = "NoName"
VK_PA1 = "PA1"
VK_OEM_CLEAR = "OEMClear"